Skip to content

Client language split #901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 32 commits into
base: master
Choose a base branch
from
Open

Client language split #901

wants to merge 32 commits into from

Conversation

stktung
Copy link
Contributor

@stktung stktung commented Jul 9, 2025

Description

In addition to splitting the clients by language, the following were done:

  • Changed the old client pages to display choice for user to select client for redirection
  • Asked sitemap client pages priorities to 0 for SEO
  • Updated bread crumbs to incorporate client name

Page previews

@stktung stktung changed the title Client split Client language split Jul 9, 2025
Copy link

cloudflare-workers-and-pages bot commented Jul 9, 2025

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 15be5cd
Status: ✅  Deploy successful!
Preview URL: https://95fd1bc9.documentation-21k.pages.dev
Branch Preview URL: https://client-split.documentation-21k.pages.dev

View logs

@stktung stktung marked this pull request as ready for review July 10, 2025 13:57
@stktung stktung requested a review from a team as a code owner July 10, 2025 13:57
@@ -11,76 +11,6 @@ For a detailed explanation of projections, see the [server documentation](@serve

You can find the full sample code from this documentation page in the respective [clients repositories](https://github.com/kurrent-io/?q=client).

## Required packages
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexeyzimarev I decided to remove the package installation section in the projections docs (in go, java, nodejs, and python). We already have exactly the same thing in the client's getting-started.md.

@stktung
Copy link
Contributor Author

stktung commented Jul 10, 2025

@alexeyzimarev I know we excluded a few observability pages for the clients that doesn't have it (python, go, rust). I have thoughts about adding them back in and just tell users explicitly that "this is not supported for this client yet!". That way they won't be wondering if we are just missing a docs page or the client doesn't have this feature.

any thoughts?

@stktung stktung requested a review from alexeyzimarev July 10, 2025 14:14
@stktung
Copy link
Contributor Author

stktung commented Jul 11, 2025

@alexeyzimarev I need help about a problem I came across.

I'm not sure how to properly redirect links of the old client pages that contain anchors . For example, how do we redirect https://docs.kurrent.io/clients/grpc/persistent-subscriptions.html#subscribing-to-all to the right page?

Right now my PR will redirect them to a page to allow them to select a language. But the anchor in the link will be lost in the process. It'll be great if we can carry that anchor forward to the lang specific page, but I don't know vuepress enough to quickly figure out how to do this. Do you have any idea?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants